Fix regex in CodeQL TextMate grammar that was silently failing #3903
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aeisenberg
reviewed
Jan 20, 2025
Contributor
Author
|
@aeisenberg any concerns with landing this? |
Contributor
|
Looks fine to me. Thanks for your contribution! |
aeisenberg
approved these changes
Jan 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The TM grammar for CodeQL includes an invalid regex. Specifically, in Oniguruma, lookahead is invalid when used within lookbehind. This leads to the regex failing silently in
vscode-textmate.Additionally, this makes the CodeQL grammar fail entirely when used with Shiki's JS engine (see CodeQL listed as unsupported in Shiki's JS engine compatibility report) because Shiki's JS engine doesn't fail silently for invalid Oniguruma regexes.
Because the lookahead appears at the end of the lookbehind, moving it outside of the lookbehind does not change the behavior of the regex at all (if the previous version had worked in the first place, like it would in some other regex flavors).
In this PR, I updated
extensions/ql-vscode/syntaxes/ql.tmLanguage.ymland then ran thesyntaxes/updateSyntaxscript to generate the JSON version of the grammar. I've also updated the changelog.